<!DOCTYPE html>

<html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Types and enums &#8212; Eclipse paho-mqtt  documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9a2dae69"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Changelog" href="changelog.html" />
    <link rel="prev" title="helpers" href="helpers.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  

  
  

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <section id="module-paho.mqtt.enums">
<span id="types-and-enums"></span><h1>Types and enums<a class="headerlink" href="#module-paho.mqtt.enums" title="Link to this heading">¶</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.CallbackAPIVersion">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">CallbackAPIVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.CallbackAPIVersion" title="Link to this definition">¶</a></dt>
<dd><p>Defined the arguments passed to all user-callback.</p>
<p>See each callbacks for details: <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_connect" title="paho.mqtt.client.Client.on_connect"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_connect</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_connect_fail" title="paho.mqtt.client.Client.on_connect_fail"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_connect_fail</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_disconnect" title="paho.mqtt.client.Client.on_disconnect"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_disconnect</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_message" title="paho.mqtt.client.Client.on_message"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_message</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_publish" title="paho.mqtt.client.Client.on_publish"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_publish</span></code></a>,
<a class="reference internal" href="client.html#paho.mqtt.client.Client.on_subscribe" title="paho.mqtt.client.Client.on_subscribe"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_subscribe</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_unsubscribe" title="paho.mqtt.client.Client.on_unsubscribe"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_unsubscribe</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_log" title="paho.mqtt.client.Client.on_log"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_log</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_socket_open" title="paho.mqtt.client.Client.on_socket_open"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_socket_open</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_socket_close" title="paho.mqtt.client.Client.on_socket_close"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_socket_close</span></code></a>,
<a class="reference internal" href="client.html#paho.mqtt.client.Client.on_socket_register_write" title="paho.mqtt.client.Client.on_socket_register_write"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_socket_register_write</span></code></a>, <a class="reference internal" href="client.html#paho.mqtt.client.Client.on_socket_unregister_write" title="paho.mqtt.client.Client.on_socket_unregister_write"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">on_socket_unregister_write</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.CallbackAPIVersion.VERSION1">
<span class="sig-name descname"><span class="pre">VERSION1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#paho.mqtt.enums.CallbackAPIVersion.VERSION1" title="Link to this definition">¶</a></dt>
<dd><p>The version used with paho-mqtt 1.x before introducing CallbackAPIVersion.</p>
<p>This version had different arguments depending if MQTTv5 or MQTTv3 was used. <a class="reference internal" href="#paho.mqtt.properties.Properties" title="paho.mqtt.properties.Properties"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Properties</span></code></a> &amp; <a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode" title="paho.mqtt.reasoncodes.ReasonCode"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ReasonCode</span></code></a> were missing
on some callback (apply only to MQTTv5).</p>
<p>This version is deprecated and will be removed in version 3.0.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.CallbackAPIVersion.VERSION2">
<span class="sig-name descname"><span class="pre">VERSION2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#paho.mqtt.enums.CallbackAPIVersion.VERSION2" title="Link to this definition">¶</a></dt>
<dd><p>This version fix some of the shortcoming of previous version.</p>
<p>Callback have the same signature if using MQTTv5 or MQTTv3. <a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode" title="paho.mqtt.reasoncodes.ReasonCode"><code class="xref any py py-class docutils literal notranslate"><span class="pre">ReasonCode</span></code></a> are used in MQTTv3.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">ConnackCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.ConnackCode" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode.CONNACK_ACCEPTED">
<span class="sig-name descname"><span class="pre">CONNACK_ACCEPTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#paho.mqtt.enums.ConnackCode.CONNACK_ACCEPTED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_BAD_USERNAME_PASSWORD">
<span class="sig-name descname"><span class="pre">CONNACK_REFUSED_BAD_USERNAME_PASSWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_BAD_USERNAME_PASSWORD" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_IDENTIFIER_REJECTED">
<span class="sig-name descname"><span class="pre">CONNACK_REFUSED_IDENTIFIER_REJECTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_IDENTIFIER_REJECTED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_NOT_AUTHORIZED">
<span class="sig-name descname"><span class="pre">CONNACK_REFUSED_NOT_AUTHORIZED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_NOT_AUTHORIZED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_PROTOCOL_VERSION">
<span class="sig-name descname"><span class="pre">CONNACK_REFUSED_PROTOCOL_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_PROTOCOL_VERSION" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_SERVER_UNAVAILABLE">
<span class="sig-name descname"><span class="pre">CONNACK_REFUSED_SERVER_UNAVAILABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_SERVER_UNAVAILABLE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.LogLevel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">LogLevel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.LogLevel" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.LogLevel.MQTT_LOG_DEBUG">
<span class="sig-name descname"><span class="pre">MQTT_LOG_DEBUG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">16</span></em><a class="headerlink" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_DEBUG" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.LogLevel.MQTT_LOG_ERR">
<span class="sig-name descname"><span class="pre">MQTT_LOG_ERR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_ERR" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.LogLevel.MQTT_LOG_INFO">
<span class="sig-name descname"><span class="pre">MQTT_LOG_INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_INFO" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.LogLevel.MQTT_LOG_NOTICE">
<span class="sig-name descname"><span class="pre">MQTT_LOG_NOTICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_NOTICE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.LogLevel.MQTT_LOG_WARNING">
<span class="sig-name descname"><span class="pre">MQTT_LOG_WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_WARNING" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">MQTTErrorCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_ACL_DENIED">
<span class="sig-name descname"><span class="pre">MQTT_ERR_ACL_DENIED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">12</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_ACL_DENIED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_AGAIN">
<span class="sig-name descname"><span class="pre">MQTT_ERR_AGAIN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">-1</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_AGAIN" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_AUTH">
<span class="sig-name descname"><span class="pre">MQTT_ERR_AUTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">11</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_AUTH" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_CONN_LOST">
<span class="sig-name descname"><span class="pre">MQTT_ERR_CONN_LOST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_CONN_LOST" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_CONN_REFUSED">
<span class="sig-name descname"><span class="pre">MQTT_ERR_CONN_REFUSED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_CONN_REFUSED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_ERRNO">
<span class="sig-name descname"><span class="pre">MQTT_ERR_ERRNO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">14</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_ERRNO" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_INVAL">
<span class="sig-name descname"><span class="pre">MQTT_ERR_INVAL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_INVAL" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_KEEPALIVE">
<span class="sig-name descname"><span class="pre">MQTT_ERR_KEEPALIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">16</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_KEEPALIVE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOMEM">
<span class="sig-name descname"><span class="pre">MQTT_ERR_NOMEM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOMEM" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOT_FOUND">
<span class="sig-name descname"><span class="pre">MQTT_ERR_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOT_FOUND" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOT_SUPPORTED">
<span class="sig-name descname"><span class="pre">MQTT_ERR_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOT_SUPPORTED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NO_CONN">
<span class="sig-name descname"><span class="pre">MQTT_ERR_NO_CONN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NO_CONN" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_PAYLOAD_SIZE">
<span class="sig-name descname"><span class="pre">MQTT_ERR_PAYLOAD_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_PAYLOAD_SIZE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_PROTOCOL">
<span class="sig-name descname"><span class="pre">MQTT_ERR_PROTOCOL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_PROTOCOL" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_QUEUE_SIZE">
<span class="sig-name descname"><span class="pre">MQTT_ERR_QUEUE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">15</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_QUEUE_SIZE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_SUCCESS">
<span class="sig-name descname"><span class="pre">MQTT_ERR_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_SUCCESS" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_TLS">
<span class="sig-name descname"><span class="pre">MQTT_ERR_TLS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_TLS" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_UNKNOWN">
<span class="sig-name descname"><span class="pre">MQTT_ERR_UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">13</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_UNKNOWN" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTProtocolVersion">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">MQTTProtocolVersion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.MQTTProtocolVersion" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTProtocolVersion.MQTTv31">
<span class="sig-name descname"><span class="pre">MQTTv31</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTProtocolVersion.MQTTv31" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTProtocolVersion.MQTTv311">
<span class="sig-name descname"><span class="pre">MQTTv311</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTProtocolVersion.MQTTv311" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MQTTProtocolVersion.MQTTv5">
<span class="sig-name descname"><span class="pre">MQTTv5</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#paho.mqtt.enums.MQTTProtocolVersion.MQTTv5" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">MessageState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.MessageState" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_INVALID">
<span class="sig-name descname"><span class="pre">MQTT_MS_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_INVALID" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_PUBLISH">
<span class="sig-name descname"><span class="pre">MQTT_MS_PUBLISH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_PUBLISH" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_QUEUED">
<span class="sig-name descname"><span class="pre">MQTT_MS_QUEUED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_QUEUED" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_RESEND_PUBCOMP">
<span class="sig-name descname"><span class="pre">MQTT_MS_RESEND_PUBCOMP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_RESEND_PUBCOMP" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_RESEND_PUBREL">
<span class="sig-name descname"><span class="pre">MQTT_MS_RESEND_PUBREL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_RESEND_PUBREL" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_SEND_PUBREC">
<span class="sig-name descname"><span class="pre">MQTT_MS_SEND_PUBREC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_SEND_PUBREC" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBACK">
<span class="sig-name descname"><span class="pre">MQTT_MS_WAIT_FOR_PUBACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBACK" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBCOMP">
<span class="sig-name descname"><span class="pre">MQTT_MS_WAIT_FOR_PUBCOMP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBCOMP" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBREC">
<span class="sig-name descname"><span class="pre">MQTT_MS_WAIT_FOR_PUBREC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBREC" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBREL">
<span class="sig-name descname"><span class="pre">MQTT_MS_WAIT_FOR_PUBREL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBREL" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">MessageType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.MessageType" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.AUTH">
<span class="sig-name descname"><span class="pre">AUTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">240</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.AUTH" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.CONNACK">
<span class="sig-name descname"><span class="pre">CONNACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">32</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.CONNACK" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.CONNECT">
<span class="sig-name descname"><span class="pre">CONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">16</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.CONNECT" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.DISCONNECT">
<span class="sig-name descname"><span class="pre">DISCONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">224</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.DISCONNECT" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PINGREQ">
<span class="sig-name descname"><span class="pre">PINGREQ</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">192</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PINGREQ" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PINGRESP">
<span class="sig-name descname"><span class="pre">PINGRESP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">208</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PINGRESP" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PUBACK">
<span class="sig-name descname"><span class="pre">PUBACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">64</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PUBACK" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PUBCOMP">
<span class="sig-name descname"><span class="pre">PUBCOMP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">112</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PUBCOMP" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PUBLISH">
<span class="sig-name descname"><span class="pre">PUBLISH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">48</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PUBLISH" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PUBREC">
<span class="sig-name descname"><span class="pre">PUBREC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">80</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PUBREC" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.PUBREL">
<span class="sig-name descname"><span class="pre">PUBREL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">96</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.PUBREL" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.SUBACK">
<span class="sig-name descname"><span class="pre">SUBACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">144</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.SUBACK" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.SUBSCRIBE">
<span class="sig-name descname"><span class="pre">SUBSCRIBE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">128</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.SUBSCRIBE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.UNSUBACK">
<span class="sig-name descname"><span class="pre">UNSUBACK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">176</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.UNSUBACK" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.MessageType.UNSUBSCRIBE">
<span class="sig-name descname"><span class="pre">UNSUBSCRIBE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">160</span></em><a class="headerlink" href="#paho.mqtt.enums.MessageType.UNSUBSCRIBE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.enums.PahoClientMode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.enums.</span></span><span class="sig-name descname"><span class="pre">PahoClientMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.enums.PahoClientMode" title="Link to this definition">¶</a></dt>
<dd><dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.PahoClientMode.MQTT_BRIDGE">
<span class="sig-name descname"><span class="pre">MQTT_BRIDGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#paho.mqtt.enums.PahoClientMode.MQTT_BRIDGE" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="paho.mqtt.enums.PahoClientMode.MQTT_CLIENT">
<span class="sig-name descname"><span class="pre">MQTT_CLIENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#paho.mqtt.enums.PahoClientMode.MQTT_CLIENT" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py exception" id="module-paho.mqtt.properties">
<dt class="sig sig-object py" id="paho.mqtt.properties.MQTTException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">MQTTException</span></span><a class="headerlink" href="#paho.mqtt.properties.MQTTException" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="paho.mqtt.properties.MalformedPacket">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">MalformedPacket</span></span><a class="headerlink" href="#paho.mqtt.properties.MalformedPacket" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">Properties</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packetType</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties" title="Link to this definition">¶</a></dt>
<dd><p>MQTT v5.0 properties class.</p>
<p>See Properties.names for a list of accepted property names along with their numeric values.</p>
<p>See Properties.properties for the data type of each property.</p>
<p>Example of use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">publish_properties</span> <span class="o">=</span> <span class="n">Properties</span><span class="p">(</span><span class="n">PacketTypes</span><span class="o">.</span><span class="n">PUBLISH</span><span class="p">)</span>
<span class="n">publish_properties</span><span class="o">.</span><span class="n">UserProperty</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">,</span> <span class="s2">&quot;2&quot;</span><span class="p">)</span>
<span class="n">publish_properties</span><span class="o">.</span><span class="n">UserProperty</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;c&quot;</span><span class="p">,</span> <span class="s2">&quot;3&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>First the object is created with packet type as argument, no properties will be present at
this point. Then properties are added as attributes, the name of which is the string property
name without the spaces.</p>
<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.allowsMultiple">
<span class="sig-name descname"><span class="pre">allowsMultiple</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compressedName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.allowsMultiple" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.clear" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.getIdentFromName">
<span class="sig-name descname"><span class="pre">getIdentFromName</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compressedName</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.getIdentFromName" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.getNameFromIdent">
<span class="sig-name descname"><span class="pre">getNameFromIdent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.getNameFromIdent" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.isEmpty">
<span class="sig-name descname"><span class="pre">isEmpty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.isEmpty" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.json" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.pack">
<span class="sig-name descname"><span class="pre">pack</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.pack" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.readProperty">
<span class="sig-name descname"><span class="pre">readProperty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">propslen</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.readProperty" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.unpack">
<span class="sig-name descname"><span class="pre">unpack</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.unpack" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.Properties.writeProperty">
<span class="sig-name descname"><span class="pre">writeProperty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.Properties.writeProperty" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.properties.VariableByteIntegers">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">VariableByteIntegers</span></span><a class="headerlink" href="#paho.mqtt.properties.VariableByteIntegers" title="Link to this definition">¶</a></dt>
<dd><p>MQTT variable byte integer helper class.  Used
in several places in MQTT v5.0 properties.</p>
<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.VariableByteIntegers.decode">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.VariableByteIntegers.decode" title="Link to this definition">¶</a></dt>
<dd><p>Get the value of a multi-byte integer from a buffer
Return the value, and the number of bytes used.</p>
<p>[MQTT-1.5.5-1] the encoded value MUST use the minimum number of bytes necessary to represent the value</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.properties.VariableByteIntegers.encode">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">encode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.VariableByteIntegers.encode" title="Link to this definition">¶</a></dt>
<dd><p>Convert an integer 0 &lt;= x &lt;= 268435455 into multi-byte format.
Returns the buffer converted from the integer.</p>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.readBytes">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">readBytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.readBytes" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.readInt16">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">readInt16</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buf</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.readInt16" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.readInt32">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">readInt32</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buf</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.readInt32" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.readUTF">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">readUTF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxlen</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.readUTF" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.writeBytes">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">writeBytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.writeBytes" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.writeInt16">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">writeInt16</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">length</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.writeInt16" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.writeInt32">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">writeInt32</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">length</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.writeInt32" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="paho.mqtt.properties.writeUTF">
<span class="sig-prename descclassname"><span class="pre">paho.mqtt.properties.</span></span><span class="sig-name descname"><span class="pre">writeUTF</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.properties.writeUTF" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py class" id="module-paho.mqtt.reasoncodes">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.reasoncodes.</span></span><span class="sig-name descname"><span class="pre">ReasonCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">packetType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aName</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'Success'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">identifier</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode" title="Link to this definition">¶</a></dt>
<dd><p>MQTT version 5.0 reason codes class.</p>
<p>See ReasonCode.names for a list of possible numeric values along with their
names and the packets to which they apply.</p>
<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.getId">
<span class="sig-name descname"><span class="pre">getId</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.getId" title="Link to this definition">¶</a></dt>
<dd><p>Get the numeric id corresponding to a reason code name.</p>
<p>Used when setting the reason code for a packetType
check that only valid codes for the packet are set.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.getName">
<span class="sig-name descname"><span class="pre">getName</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.getName" title="Link to this definition">¶</a></dt>
<dd><p>Returns the reason code name corresponding to the numeric value which is set.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.is_failure">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_failure</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.is_failure" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.json" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.pack">
<span class="sig-name descname"><span class="pre">pack</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.pack" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.set" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCode.unpack">
<span class="sig-name descname"><span class="pre">unpack</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCode.unpack" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="paho.mqtt.reasoncodes.ReasonCodes">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">paho.mqtt.reasoncodes.</span></span><span class="sig-name descname"><span class="pre">ReasonCodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#paho.mqtt.reasoncodes.ReasonCodes" title="Link to this definition">¶</a></dt>
<dd></dd></dl>

</section>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Eclipse paho-mqtt</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="client.html">client module</a></li>
<li class="toctree-l1"><a class="reference internal" href="helpers.html">helpers</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Types and enums</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.CallbackAPIVersion"><code class="docutils literal notranslate"><span class="pre">CallbackAPIVersion</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.CallbackAPIVersion.VERSION1"><code class="docutils literal notranslate"><span class="pre">CallbackAPIVersion.VERSION1</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.CallbackAPIVersion.VERSION2"><code class="docutils literal notranslate"><span class="pre">CallbackAPIVersion.VERSION2</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode"><code class="docutils literal notranslate"><span class="pre">ConnackCode</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode.CONNACK_ACCEPTED"><code class="docutils literal notranslate"><span class="pre">ConnackCode.CONNACK_ACCEPTED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_BAD_USERNAME_PASSWORD"><code class="docutils literal notranslate"><span class="pre">ConnackCode.CONNACK_REFUSED_BAD_USERNAME_PASSWORD</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_IDENTIFIER_REJECTED"><code class="docutils literal notranslate"><span class="pre">ConnackCode.CONNACK_REFUSED_IDENTIFIER_REJECTED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_NOT_AUTHORIZED"><code class="docutils literal notranslate"><span class="pre">ConnackCode.CONNACK_REFUSED_NOT_AUTHORIZED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_PROTOCOL_VERSION"><code class="docutils literal notranslate"><span class="pre">ConnackCode.CONNACK_REFUSED_PROTOCOL_VERSION</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.ConnackCode.CONNACK_REFUSED_SERVER_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">ConnackCode.CONNACK_REFUSED_SERVER_UNAVAILABLE</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.LogLevel"><code class="docutils literal notranslate"><span class="pre">LogLevel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_DEBUG"><code class="docutils literal notranslate"><span class="pre">LogLevel.MQTT_LOG_DEBUG</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_ERR"><code class="docutils literal notranslate"><span class="pre">LogLevel.MQTT_LOG_ERR</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_INFO"><code class="docutils literal notranslate"><span class="pre">LogLevel.MQTT_LOG_INFO</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_NOTICE"><code class="docutils literal notranslate"><span class="pre">LogLevel.MQTT_LOG_NOTICE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.LogLevel.MQTT_LOG_WARNING"><code class="docutils literal notranslate"><span class="pre">LogLevel.MQTT_LOG_WARNING</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_ACL_DENIED"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_ACL_DENIED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_AGAIN"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_AGAIN</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_AUTH"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_AUTH</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_CONN_LOST"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_CONN_LOST</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_CONN_REFUSED"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_CONN_REFUSED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_ERRNO"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_ERRNO</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_INVAL"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_INVAL</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_KEEPALIVE"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_KEEPALIVE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOMEM"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_NOMEM</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOT_FOUND"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_NOT_FOUND</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NOT_SUPPORTED"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_NOT_SUPPORTED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_NO_CONN"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_NO_CONN</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_PAYLOAD_SIZE"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_PAYLOAD_SIZE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_PROTOCOL"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_PROTOCOL</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_QUEUE_SIZE"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_QUEUE_SIZE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_SUCCESS"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_SUCCESS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_TLS"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_TLS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTErrorCode.MQTT_ERR_UNKNOWN"><code class="docutils literal notranslate"><span class="pre">MQTTErrorCode.MQTT_ERR_UNKNOWN</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.MQTTProtocolVersion"><code class="docutils literal notranslate"><span class="pre">MQTTProtocolVersion</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTProtocolVersion.MQTTv31"><code class="docutils literal notranslate"><span class="pre">MQTTProtocolVersion.MQTTv31</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTProtocolVersion.MQTTv311"><code class="docutils literal notranslate"><span class="pre">MQTTProtocolVersion.MQTTv311</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MQTTProtocolVersion.MQTTv5"><code class="docutils literal notranslate"><span class="pre">MQTTProtocolVersion.MQTTv5</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.MessageState"><code class="docutils literal notranslate"><span class="pre">MessageState</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_INVALID"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_INVALID</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_PUBLISH"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_PUBLISH</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_QUEUED"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_QUEUED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_RESEND_PUBCOMP"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_RESEND_PUBCOMP</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_RESEND_PUBREL"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_RESEND_PUBREL</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_SEND_PUBREC"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_SEND_PUBREC</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBACK"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_WAIT_FOR_PUBACK</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBCOMP"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_WAIT_FOR_PUBCOMP</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBREC"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_WAIT_FOR_PUBREC</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageState.MQTT_MS_WAIT_FOR_PUBREL"><code class="docutils literal notranslate"><span class="pre">MessageState.MQTT_MS_WAIT_FOR_PUBREL</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.MessageType"><code class="docutils literal notranslate"><span class="pre">MessageType</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.AUTH"><code class="docutils literal notranslate"><span class="pre">MessageType.AUTH</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.CONNACK"><code class="docutils literal notranslate"><span class="pre">MessageType.CONNACK</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.CONNECT"><code class="docutils literal notranslate"><span class="pre">MessageType.CONNECT</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.DISCONNECT"><code class="docutils literal notranslate"><span class="pre">MessageType.DISCONNECT</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PINGREQ"><code class="docutils literal notranslate"><span class="pre">MessageType.PINGREQ</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PINGRESP"><code class="docutils literal notranslate"><span class="pre">MessageType.PINGRESP</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PUBACK"><code class="docutils literal notranslate"><span class="pre">MessageType.PUBACK</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PUBCOMP"><code class="docutils literal notranslate"><span class="pre">MessageType.PUBCOMP</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PUBLISH"><code class="docutils literal notranslate"><span class="pre">MessageType.PUBLISH</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PUBREC"><code class="docutils literal notranslate"><span class="pre">MessageType.PUBREC</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.PUBREL"><code class="docutils literal notranslate"><span class="pre">MessageType.PUBREL</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.SUBACK"><code class="docutils literal notranslate"><span class="pre">MessageType.SUBACK</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.SUBSCRIBE"><code class="docutils literal notranslate"><span class="pre">MessageType.SUBSCRIBE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.UNSUBACK"><code class="docutils literal notranslate"><span class="pre">MessageType.UNSUBACK</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.MessageType.UNSUBSCRIBE"><code class="docutils literal notranslate"><span class="pre">MessageType.UNSUBSCRIBE</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.enums.PahoClientMode"><code class="docutils literal notranslate"><span class="pre">PahoClientMode</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.PahoClientMode.MQTT_BRIDGE"><code class="docutils literal notranslate"><span class="pre">PahoClientMode.MQTT_BRIDGE</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.enums.PahoClientMode.MQTT_CLIENT"><code class="docutils literal notranslate"><span class="pre">PahoClientMode.MQTT_CLIENT</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.MQTTException"><code class="docutils literal notranslate"><span class="pre">MQTTException</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.MalformedPacket"><code class="docutils literal notranslate"><span class="pre">MalformedPacket</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.Properties"><code class="docutils literal notranslate"><span class="pre">Properties</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.allowsMultiple"><code class="docutils literal notranslate"><span class="pre">Properties.allowsMultiple()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.clear"><code class="docutils literal notranslate"><span class="pre">Properties.clear()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.getIdentFromName"><code class="docutils literal notranslate"><span class="pre">Properties.getIdentFromName()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.getNameFromIdent"><code class="docutils literal notranslate"><span class="pre">Properties.getNameFromIdent()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.isEmpty"><code class="docutils literal notranslate"><span class="pre">Properties.isEmpty()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.json"><code class="docutils literal notranslate"><span class="pre">Properties.json()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.pack"><code class="docutils literal notranslate"><span class="pre">Properties.pack()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.readProperty"><code class="docutils literal notranslate"><span class="pre">Properties.readProperty()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.unpack"><code class="docutils literal notranslate"><span class="pre">Properties.unpack()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.Properties.writeProperty"><code class="docutils literal notranslate"><span class="pre">Properties.writeProperty()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.VariableByteIntegers"><code class="docutils literal notranslate"><span class="pre">VariableByteIntegers</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.VariableByteIntegers.decode"><code class="docutils literal notranslate"><span class="pre">VariableByteIntegers.decode()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.properties.VariableByteIntegers.encode"><code class="docutils literal notranslate"><span class="pre">VariableByteIntegers.encode()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.readBytes"><code class="docutils literal notranslate"><span class="pre">readBytes()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.readInt16"><code class="docutils literal notranslate"><span class="pre">readInt16()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.readInt32"><code class="docutils literal notranslate"><span class="pre">readInt32()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.readUTF"><code class="docutils literal notranslate"><span class="pre">readUTF()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.writeBytes"><code class="docutils literal notranslate"><span class="pre">writeBytes()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.writeInt16"><code class="docutils literal notranslate"><span class="pre">writeInt16()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.writeInt32"><code class="docutils literal notranslate"><span class="pre">writeInt32()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.properties.writeUTF"><code class="docutils literal notranslate"><span class="pre">writeUTF()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode"><code class="docutils literal notranslate"><span class="pre">ReasonCode</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.getId"><code class="docutils literal notranslate"><span class="pre">ReasonCode.getId()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.getName"><code class="docutils literal notranslate"><span class="pre">ReasonCode.getName()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.is_failure"><code class="docutils literal notranslate"><span class="pre">ReasonCode.is_failure</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.json"><code class="docutils literal notranslate"><span class="pre">ReasonCode.json()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.pack"><code class="docutils literal notranslate"><span class="pre">ReasonCode.pack()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.set"><code class="docutils literal notranslate"><span class="pre">ReasonCode.set()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCode.unpack"><code class="docutils literal notranslate"><span class="pre">ReasonCode.unpack()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#paho.mqtt.reasoncodes.ReasonCodes"><code class="docutils literal notranslate"><span class="pre">ReasonCodes</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="migrations.html">Migrations</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="helpers.html" title="previous chapter">helpers</a></li>
      <li>Next: <a href="changelog.html" title="next chapter">Changelog</a></li>
  </ul></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &#169;2024, Eclipse.
      
      |
      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
      
      |
      <a href="_sources/types.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>